/*-
 * UDHI.java          TP-User-Data-Header-Indicator (TP-UDHI)
 *
 * $LastChangedBy: stein $
 * $LastChangedRevision: 95 $
 * $LastChangedDate: 2007-02-13 16:19:24 +0000 (Tue, 13 Feb 2007) $
 * $HeadURL: svn://localhost/SMS/src/com/googlecode/attention/sms/pdu/UDHI.java $
 *
 * Copyright (c) 2007, Stein Gunnar Bakkeby
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Stein Gunnar Bakkeby nor the names of its
 *       contributors may be used to endorse or promote products derived
 *       from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.googlecode.attention.sms.pdu;

/**
 * TP-User-Data-Header-Indicator (TP-UDHI).
 * <BR>
 * The TP-User-Data-Header-Indicator is a 1 bit field within
 * bit 6 of the first octet of the following six PDUs:
 * <BR>
 * <BR> - SMS-SUBMIT,
 * <BR> - SMS-SUBMIT-REPORT,
 * <BR> - SMS-DELIVER,
 * <BR> - SMS-DELIVER-REPORT,
 * <BR> - SMS-STATUS-REPORT,
 * <BR> - SMS-COMMAND.
 * <BR>
 * <BR>TP-UDHI has the following values.
 * <BR>
 * <BR>Bit no. 6:
 * <BR><TABLE>
 * <TR><TD>0</TD><TD>The TP-UD field contains only the short message</TD></TR>
 * <TR><TD>1</TD><TD>The beginning of the TP-UD field contains a Header in addition to the short message.</TD></TR>
 * </TABLE>
 * 
 * @author Stein Gunnar Bakkeby
 */
public enum UDHI {

  /** The TP-UD field contains only the short message (e.g. no header). */
  SHORT_MESSAGE_ONLY(0),
  /**
   * The beginning of the TP-UD field contains a Header
   * in addition to the short message.
   */
  HEADER_PRESENT(0x40); // B6

  /** The binary value of the UDHI. */
  public final int value;
  
  private UDHI(final int value) {
    this.value = value;
  }
  
  /**
   * This will parse an integer and return the respective UDHI enum value.
   * The method will return the enum based on bit6 of the integer.
   * 
   * @param value The integer to parse
   * @return The respective UDHI enum value
   */
  public static UDHI parse(int value) {
    switch (value & 0x40) {
    case 1:
      return HEADER_PRESENT;
    case 0x40:
      return HEADER_PRESENT;
    case 0:
    default:
      return SHORT_MESSAGE_ONLY;
    }
  }
}